feat(API): Document new query parameters#393
Merged
Mikko Karkee (Varpuspaavi) merged 4 commits intomasterfrom Aug 28, 2023
Merged
feat(API): Document new query parameters#393Mikko Karkee (Varpuspaavi) merged 4 commits intomasterfrom
Mikko Karkee (Varpuspaavi) merged 4 commits intomasterfrom
Conversation
Contributor
Author
|
I will try to bump the GO version on the generated CLI PR jablan |
jablan
reviewed
Aug 24, 2023
| --project_id <project_id> \ | ||
| --key_id <key_id> \ | ||
| --branch my-feature-branch \ | ||
| --data '{"branch":"my-feature-branch", "filters": ["unread", "read"], "query": "Some comment content", "locale_ids": ["someId"] }' \ |
Collaborator
There was a problem hiding this comment.
I believe this is a GET request, so the parameters should be passed as query params, not as JSON?
Contributor
Author
There was a problem hiding this comment.
Adjusted. This is probably something we have to check for every endpoint also, seems like it's pretty mixed atm 🤔
jablan
requested changes
Aug 28, 2023
Collaborator
jablan
left a comment
jablan
left a comment
There was a problem hiding this comment.
the curl examples seem wrong, with parameters in a data payload rather than in the query. have you tried these examples against the app, I'm curious whether both ways of passing them work?
| -u USERNAME_OR_ACCESS_TOKEN \ | ||
| -X GET \ | ||
| -d '{"branch":"my-feature-branch"}' \ | ||
| -d '{"branch":"my-feature-branch", "filters": ["unread", "read"], "query": "Some comment content"}' \ |
Collaborator
There was a problem hiding this comment.
this should go into query I believe
| -u USERNAME_OR_ACCESS_TOKEN | ||
| -u USERNAME_OR_ACCESS_TOKEN \ | ||
| -X GET \ | ||
| -d '{"branch":"my-feature-branch", "filters": ["unread", "read"], "query": "Some comment content", "locale_ids": ["someId"] }' \ |
jablan
approved these changes
Aug 28, 2023
This was referenced Aug 28, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
https://github.com/phrase/phrase/pull/11643
https://memsourcegroup.atlassian.net/browse/TSE-869